package fields

Import Path
	github.com/K-Phoen/grabana/timeseries/fields (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	    matcher.go
	    override.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type FieldType string (basic type)

		As Inputs Of (at least one exported)
			func ByType(fieldType FieldType) Matcher
		As Types Of (only one)
			const FieldTypeTime

	 type Matcher (func)

		As Outputs Of (at least 4)
			func ByName(name string) Matcher
			func ByQuery(ref string) Matcher
			func ByRegex(regex string) Matcher
			func ByType(fieldType FieldType) Matcher
		As Inputs Of (at least one exported)
			func github.com/K-Phoen/grabana/timeseries.FieldOverride(m Matcher, opts ...OverrideOption) timeseries.Option

	 type OverrideOption (func)

		As Outputs Of (at least 6)
			func AxisPlacement(placement axis.PlacementMode) OverrideOption
			func FillOpacity(opacity int) OverrideOption
			func FixedColorScheme(color string) OverrideOption
			func NegativeY() OverrideOption
			func Stack(mode StackMode) OverrideOption
			func Unit(unit string) OverrideOption
		As Inputs Of (at least one exported)
			func github.com/K-Phoen/grabana/timeseries.FieldOverride(m Matcher, opts ...OverrideOption) timeseries.Option

	 type StackMode string (basic type)
		StackMode configures mode of series stacking.
		FIXME: copied here to avoid circular imports with parent package

		As Inputs Of (at least one exported)
			func Stack(mode StackMode) OverrideOption
		As Types Of (total 3)
			const NormalStack
			const PercentStack
			const Unstacked


Package-Level Functions (total 10)

	 func AxisPlacement(placement axis.PlacementMode) OverrideOption
		AxisPlacement overrides how the axis should be placed in the panel.

	 func ByName(name string) Matcher
		ByName matches a specific field name.

	 func ByQuery(ref string) Matcher
		ByQuery matches all fields returned by the given query.

	 func ByRegex(regex string) Matcher
		ByRegex matches fields names using a regex.

	 func ByType(fieldType FieldType) Matcher
		ByType matches fields with a specific type.

	 func FillOpacity(opacity int) OverrideOption
		FillOpacity overrides the opacity.

	 func FixedColorScheme(color string) OverrideOption
		FixedColorScheme forces the use of a fixed color scheme.

	 func NegativeY() OverrideOption
		NegativeY flips the results to negative values on the Y axis.

	 func Stack(mode StackMode) OverrideOption
		Stack overrides if the series should be stacked and using which mode (default not stacked).

	 func Unit(unit string) OverrideOption
		Unit overrides the unit.


Package-Level Constants (total 4)

	const FieldTypeTime FieldType = "time"
	const NormalStack StackMode = "normal"
		NormalStack will stack series as absolute numbers

	const PercentStack StackMode = "percent"
		PercentStack will stack series as percents

	const Unstacked StackMode = "none"
		Unstacked will not stack series

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.